chore(release): set up conventional commit changelog tool. Part of #3920 #4033
Conversation
Bobgy
added
the
cherrypick-approved
|
This change is |
This reverts commit de82f4c.
|
/assign @rmgogogo @jingzhang36 |
|
/cc @Ark-kun @numerology |
Bobgy
changed the title
|
/lgtm |
.github/pull_request_template.md
Outdated
| @@ -2,6 +2,14 @@ | |||
|
|
|||
|
|
|||
| **Checklist:** | |||
| - [ ] PR title should follow our convention. Examples: | |||
There was a problem hiding this comment.
@joeliedtke Can you also review this section?
Thanks!
| @@ -28,6 +28,66 @@ use GitHub pull requests for this purpose. Consult | |||
| [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more | |||
| information on using pull requests. | |||
|
|
|||
| ## Pull Request Title Convention | |||
There was a problem hiding this comment.
@joeliedtke and this section
.github/pull_request_template.md
Outdated
| @@ -2,6 +2,14 @@ | |||
|
|
|||
|
|
|||
| **Checklist:** | |||
| - [ ] PR title should follow our convention. Examples: | |||
There was a problem hiding this comment.
Suggested revision:
-
The title for your pull request (PR) should follow our title convention. Learn more about the pull request title convention used in this repository.
PR titles examples:
fix(frontend): fixes empty page. Fixes #1234
Usefixto indicate that this PR resolves an open issue.feat(backend): configurable service account. Fixes #1234, fixes #1235
Usefeatto indicate that this PR adds a new feature.chore: refactor some files
Usechoreto specify that this PR cleans up or improves the affected files.test: fix CI failure. Part of #1234
Usepart ofto indicate that a PR is working on an issue, but shouldn't close the issue when merged.
|
New changes are detected. LGTM label has been removed. |
|
Hi @joeliedtke, thanks a lot for the detailed suggestions! |
|
I'm getting this in first to inform the community about the change, @joeliedtke if you have further comments, I can send a following up PR. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Bobgy The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/retest |
2 similar comments
|
/retest |
|
/retest |
(#4033) * chore(release): set up conventional-commits/standard-version * chore(release): add contribution doc and PR template for conventional PR title * Example changelog * Revert "Example changelog" This reverts commit bf5136c. * Fix VERSION having extra line ending * Add urls to CHANGELOG.md * Add script to fix changelog format * Revert "Add urls to CHANGELOG.md" This reverts commit de82f4c. * Integrate changelog process into release-imp.sh * Updated according to @joeliedtke's suggestions
…beflow#3920 (kubeflow#4033) * chore(release): set up conventional-commits/standard-version * chore(release): add contribution doc and PR template for conventional PR title * Example changelog * Revert "Example changelog" This reverts commit bf5136c. * Fix VERSION having extra line ending * Add urls to CHANGELOG.md * Add script to fix changelog format * Revert "Add urls to CHANGELOG.md" This reverts commit de82f4c. * Integrate changelog process into release-imp.sh * Updated according to @joeliedtke's suggestions
Description of your changes:
set up conventional commit changelog tool
Part of #3920
an example changelog can be viewed at de82f4c#diff-4ac32a78649ca5bdd8e0ba38b7006a1e
documentation of the tool can be found at https://github.com/conventional-changelog/standard-version.
We configure it to also show uncategorized PRs to be compatible with existing PRs.
Checklist:
Do you want this PR cherry picked to release branch?
If yes, please either
cherrypick-approved, so that release managerwill handle it in batch
(You can refer to RELEASE.md for how to do it.)